package org.dromara.common.excel.core;

import cn.hutool.core.util.StrUtil;
import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.event.AnalysisEventListener;
import com.alibaba.excel.exception.ExcelAnalysisException;
import com.alibaba.excel.exception.ExcelDataConvertException;
import org.dromara.common.core.utils.StreamUtils;
import org.dromara.common.core.utils.ValidatorUtils;
import org.dromara.common.json.utils.JsonUtils;
import jakarta.validation.ConstraintViolation;
import jakarta.validation.ConstraintViolationException;
import lombok.NoArgsConstructor;
import lombok.extern.slf4j.Slf4j;

import java.util.Map;
import java.util.Set;


/**
 * @Author 刘武贵
 * @Date 2024/8/15 22:00
 * @Description 功能描述：Excel 导入监听
 */
/**
 * 默认Excel监听器类，用于在分析Excel数据时进行事件监听
 *
 * @param <T> 泛型参数，表示解析出来的每行数据对象的类型
 */
@Slf4j
@NoArgsConstructor
public class DefaultExcelListener<T> extends AnalysisEventListener<T> implements ExcelListener<T> {

    /**
     * 是否Validator检验，默认为是
     */
    private Boolean isValidate = Boolean.TRUE;

    /**
     * excel 表头数据
     */
    private Map<Integer, String> headMap;

    /**
     * 导入回执
     */
    private ExcelResult<T> excelResult;

    /**
     * 构造函数，用于初始化DefaultExcelListener对象
     * @param isValidate 一个布尔值，用于确定是否在监听过程中进行数据校验
     */
    public DefaultExcelListener(boolean isValidate) {
        // 初始化Excel结果对象，使用DefaultExcelResult实现类
        this.excelResult = new DefaultExcelResult<>();
        // 将构造函数传入的isValidate值赋给类成员变量isValidate，决定是否进行数据校验
        this.isValidate = isValidate;
    }

    /**
     * 处理异常
     *
     * 处理解析过程中的异常
     * 根据不同的异常类型，记录不同的错误信息
     * 如果是数据转换异常，记录具体的行号和列号
     * 如果是数据校验异常，记录具体的校验错误信息
     * @param exception ExcelDataConvertException 解析过程中抛出的异常
     * @param context   Excel 上下文 解析上下文
     * @throws Exception 抛出解析异常
     */
    @Override
    public void onException(Exception exception, AnalysisContext context) throws Exception {
        String errMsg = null;
        // 检查是否为数据转换异常
        if (exception instanceof ExcelDataConvertException excelDataConvertException) {
            // 如果是某一个单元格的转换异常 能获取到具体行号
            // 获取发生异常的行号和列号
            Integer rowIndex = excelDataConvertException.getRowIndex();
            Integer columnIndex = excelDataConvertException.getColumnIndex();
            // 构造错误信息，包括行号、列号和表头名称
            errMsg = StrUtil.format("第{}行-第{}列-表头{}: 解析异常<br/>",
                rowIndex + 1, columnIndex + 1, headMap.get(columnIndex));
            // 如果开启调试日志，记录错误信息
            if (log.isDebugEnabled()) {
                log.error(errMsg);
            }
        }
        // 检查是否为数据校验异常
        if (exception instanceof ConstraintViolationException constraintViolationException) {
            // 获取所有的校验违规信息
            Set<ConstraintViolation<?>> constraintViolations = constraintViolationException.getConstraintViolations();
            // 将校验违规信息拼接成字符串
            String constraintViolationsMsg = StreamUtils.join(constraintViolations, ConstraintViolation::getMessage, ", ");
            // 构造错误信息，包括行号和校验违规详细信息
            errMsg = StrUtil.format("第{}行数据校验异常: {}", context.readRowHolder().getRowIndex() + 1, constraintViolationsMsg);
            // 如果开启调试日志，记录错误信息
            if (log.isDebugEnabled()) {
                log.error(errMsg);
            }
        }
        // 将错误信息添加到解析结果的错误列表中
        excelResult.getErrorList().add(errMsg);
        throw new ExcelAnalysisException(errMsg);
    }

    /**
     * 调用解析表头数据的方法
     * 该方法通过覆盖默认的invoke方法来处理表头数据，将表头信息存储到headMap中，并记录日志
     *
     * @param headMap 表头数据的Map对象，键为整型，值为字符串型
     * @param context 分析上下文，提供解析过程中的额外信息
     */
    @Override
    public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) {
        this.headMap = headMap;
        log.debug("解析到一条表头数据: {}", JsonUtils.toJsonString(headMap));
    }

    /**
     * 处理单条数据
     * @param data 待处理的数据对象
     * @param context 分析上下文，提供解析过程中的额外信息
     */
    @Override
    public void invoke(T data, AnalysisContext context) {
        // 如果启用了数据验证，则对数据进行验证
        if (isValidate) {
            ValidatorUtils.validate(data);
        }
        // 将处理后的数据添加到结果列表中
        excelResult.getList().add(data);
    }

    /**
     * 所有数据解析完成后执行的操作
     * @param context 分析上下文，提供解析过程中的额外信息
     */
    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        log.debug("所有数据解析完成！");
    }

    /**
     * 获取Excel解析结果
     * @return 包含解析后的数据列表和其他相关信息的Excel结果对象
     */
    @Override
    public ExcelResult<T> getExcelResult() {
        return excelResult;
    }

}
